package timeseries

Import Path
	github.com/K-Phoen/grabana/timeseries (on go.dev)

Dependency Relation
	imports 14 packages, and imported by 2 packages

Involved Source Files

	    targets.go
	    timeseries.go
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type BarAlignment int (basic type)
		BarAlignment defines how Grafana aligns bars.

		As Inputs Of (at least one exported)
			func Bars(alignment BarAlignment) Option
		As Types Of (total 3)
			const AlignAfter
			const AlignBefore
			const AlignCenter

	 type GradientType string (basic type)
		GradientType defines the mode of the gradient fill.

		As Inputs Of (at least one exported)
			func GradientMode(mode GradientType) Option
		As Types Of (total 4)
			const Hue
			const NoGradient
			const Opacity
			const Scheme

	 type LegendOption uint16 (basic type)
		LegendOption allows to configure a legend.

		As Inputs Of (at least one exported)
			func Legend(opts ...LegendOption) Option
		As Types Of (total 15)
			const AsList
			const AsTable
			const Avg
			const Bottom
			const Count
			const First
			const FirstNonNull
			const Hide
			const Last
			const LastNonNull
			const Max
			const Min
			const Range
			const Total
			const ToTheRight

	 type LineInterpolationMode string (basic type)
		LineInterpolationMode defines how Grafana interpolates series lines when drawn as lines.

		As Inputs Of (at least one exported)
			func Lines(mode LineInterpolationMode) Option
		As Types Of (total 4)
			const Linear
			const Smooth
			const StepAfter
			const StepBefore

	 type Option (func)
		Option represents an option that can be used to configure a graph panel.

		As Outputs Of (at least 28)
			func Alert(name string, opts ...alert.Option) Option
			func Axis(options ...axis.Option) Option
			func Bars(alignment BarAlignment) Option
			func ColorScheme(options ...scheme.Option) Option
			func DataSource(source string) Option
			func Description(content string) Option
			func FieldOverride(m fields.Matcher, opts ...fields.OverrideOption) Option
			func FillOpacity(value int) Option
			func GradientMode(mode GradientType) Option
			func Height(height string) Option
			func Legend(opts ...LegendOption) Option
			func Lines(mode LineInterpolationMode) Option
			func LineWidth(value int) Option
			func Links(panelLinks ...links.Link) Option
			func Points() Option
			func PointSize(value int) Option
			func Repeat(repeat string) Option
			func RepeatDirection(direction sdk.RepeatDirection) Option
			func Span(span float32) Option
			func Stack(value StackMode) Option
			func Thresholds(options ...threshold.Option) Option
			func Tooltip(mode TooltipMode) Option
			func Transparent() Option
			func WithGraphiteTarget(query string, options ...graphite.Option) Option
			func WithInfluxDBTarget(query string, options ...influxdb.Option) Option
			func WithLokiTarget(query string, options ...loki.Option) Option
			func WithPrometheusTarget(query string, options ...prometheus.Option) Option
			func WithStackdriverTarget(target *stackdriver.Stackdriver) Option
		As Inputs Of (at least 2)
			func New(title string, options ...Option) (*TimeSeries, error)
			func github.com/K-Phoen/grabana/row.WithTimeSeries(title string, options ...Option) row.Option

	 type StackMode string (basic type)
		StackMode configures mode of series stacking.

		As Inputs Of (at least one exported)
			func Stack(value StackMode) Option
		As Types Of (total 3)
			const NormalStack
			const PercentStack
			const Unstacked

	 type TimeSeries (struct)
		TimeSeries represents a time series panel.

		Fields (total 2)
			Alert *alert.Alert
			Builder *sdk.Panel
		As Outputs Of (at least one exported)
			func New(title string, options ...Option) (*TimeSeries, error)

	 type TooltipMode string (basic type)
		TooltipMode configures which series will be displayed in the tooltip.

		As Inputs Of (at least one exported)
			func Tooltip(mode TooltipMode) Option
		As Types Of (total 3)
			const AllSeries
			const NoSeries
			const SingleSeries


Package-Level Functions (total 29)

	 func Alert(name string, opts ...alert.Option) Option
		Alert creates an alert for this graph.

	 func Axis(options ...axis.Option) Option
		Axis configures the axis for this time series.

	 func Bars(alignment BarAlignment) Option
		Bars displays the series as bars, with a given alignment strategy.

	 func ColorScheme(options ...scheme.Option) Option
		ColorScheme configures the color scheme.

	 func DataSource(source string) Option
		DataSource sets the data source to be used by the graph.

	 func Description(content string) Option
		Description annotates the current visualization with a human-readable description.

	 func FieldOverride(m fields.Matcher, opts ...fields.OverrideOption) Option
		FieldOverride allows overriding visualization options.

	 func FillOpacity(value int) Option
		FillOpacity defines the opacity level of the series. The lower the value, the more transparent.

	 func GradientMode(mode GradientType) Option
		GradientMode sets the mode of the gradient fill.

	 func Height(height string) Option
		Height sets the height of the panel, in pixels. Example: "400px".

	 func Legend(opts ...LegendOption) Option
		Legend defines what should be shown in the legend.

	 func Lines(mode LineInterpolationMode) Option
		Lines displays the series as lines, with a given interpolation strategy.

	 func LineWidth(value int) Option
		LineWidth defines the width of the line for a series (default 1, max 10, 0 is none).

	 func Links(panelLinks ...links.Link) Option
		Links adds links to be displayed on this panel.

	 func New(title string, options ...Option) (*TimeSeries, error)
		New creates a new time series panel.

	 func Points() Option
		Points displays the series as points.

	 func PointSize(value int) Option
		PointSize adjusts the size of points.

	 func Repeat(repeat string) Option
		Repeat configures repeating a panel for a variable

	 func RepeatDirection(direction sdk.RepeatDirection) Option
		RepeatDirection configures repeating vertical or horizontal

	 func Span(span float32) Option
		Span sets the width of the panel, in grid units. Should be a positive
		number between 1 and 12. Example: 6.

	 func Stack(value StackMode) Option
		Stack defines if the series should be stacked and using which mode (default not stacked).

	 func Thresholds(options ...threshold.Option) Option
		Thresholds configures the thresholds for this time series.

	 func Tooltip(mode TooltipMode) Option
		Tooltip configures the tooltip content.

	 func Transparent() Option
		Transparent makes the background transparent.

	 func WithGraphiteTarget(query string, options ...graphite.Option) Option
		WithGraphiteTarget adds a Graphite target to the table.

	 func WithInfluxDBTarget(query string, options ...influxdb.Option) Option
		WithInfluxDBTarget adds an InfluxDB target to the graph.

	 func WithLokiTarget(query string, options ...loki.Option) Option
		WithLokiTarget adds a loki query to the graph.

	 func WithPrometheusTarget(query string, options ...prometheus.Option) Option
		WithPrometheusTarget adds a prometheus query to the graph.

	 func WithStackdriverTarget(target *stackdriver.Stackdriver) Option
		WithStackdriverTarget adds a stackdriver query to the graph.


Package-Level Constants (total 32)

	const AlignAfter BarAlignment = 1
		The bar is drawn after the point. The point is placed on the leading corner of the bar.

	const AlignBefore BarAlignment = -1
		The bar is drawn before the point. The point is placed on the trailing corner of the bar.

	const AlignCenter BarAlignment = 0
		The bar is drawn around the point. The point is placed in the center of the bar.

	const AllSeries TooltipMode = "multi"
		AllSeries will display all series.

	const AsList LegendOption = 2
		AsList displays the legend as a list.

	const AsTable LegendOption = 1
		AsTable displays the legend as a table.

	const Avg LegendOption = 7
		Avg displays the average of the series.

	const Bottom LegendOption = 3
		Bottom displays the legend below the graph.

	const Count LegendOption = 13
		Count displays the number of value in the series.

	const First LegendOption = 8
		First displays the first value of the series.

	const FirstNonNull LegendOption = 9
		FirstNonNull displays the first non-null value of the series.

	const Hide LegendOption = 0
		Hide keeps the legend from being displayed.

	const Hue GradientType = "hue"
		Gradient color is generated based on the hue of the line color.

	const Last LegendOption = 10
		Last displays the last value of the series.

	const LastNonNull LegendOption = 11
		LastNonNull displays the last non-null value of the series.

	const Linear LineInterpolationMode = "linear"
		Points are joined by straight lines.

	const Max LegendOption = 6
		Max displays the largest value of the series.

	const Min LegendOption = 5
		Min displays the smallest value of the series.

	const NoGradient GradientType = "none"
		No gradient fill.

	const NormalStack StackMode = "normal"
		NormalStack will stack series as absolute numbers

	const NoSeries TooltipMode = "none"
		NoSeries will hide the tooltip completely.

	const Opacity GradientType = "opacity"
		Transparency of the gradient is calculated based on the values on the y-axis.
		Opacity of the fill is increasing with the values on the Y-axis.

	const PercentStack StackMode = "percent"
		PercentStack will stack series as percents

	const Range LegendOption = 14
		Range displays the difference between the minimum and maximum values.

	const Scheme GradientType = "scheme"
		In this mode the whole bar will use a color gradient defined by the color scheme.

	const SingleSeries TooltipMode = "single"
		SingleSeries will only display the hovered series.

	const Smooth LineInterpolationMode = "smooth"
		Points are joined by curved lines resulting in smooth transitions between points.

	const StepAfter LineInterpolationMode = "stepAfter"
		Line is displayed as steps between points. Points are rendered at the beginning of the step.

	const StepBefore LineInterpolationMode = "stepBefore"
		The line is displayed as steps between points. Points are rendered at the end of the step.

	const Total LegendOption = 12
		Total displays the sum of values in the series.

	const ToTheRight LegendOption = 4
		ToTheRight displays the legend on the right side of the graph.

	const Unstacked StackMode = "none"
		Unstacked will not stack series

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.